Skip to main content

updateAppointment​

updateAppointment

Path Parameters
    appointment_uuid string required

    appointment_uuid

Header Parameters
    authorization string required

    authorization

Request Body required

request

    appointmentKey string
    appointmentMetaData object
    dmsMetaData object
    dealerAssociateId string
    description string
    title string

    Possible values: [SUCCESS, FAILURE]

    type string

    Possible values: [PUSH, PULL]

    vehicleUuid string
    assignedUser object
    departmentUuid string
    isMobileServiceTechnician boolean
    isValid boolean
    userUuid string
    customerVehicleUuid string
    dealerDepartmentUuidList string[]
    destinationAddress string
    destinationLatitude double
    destinationLongitude double
    emailPreference boolean
    internalNotes string
    lastMileage string
    notifyCustomer boolean
    orderNumber string
    orderUuid string
    platform string

    Possible values: [DEALER_APP, WEB, MOBILE_APP, DMS, TRANSPORTATION_EVENTS_CONSUMER]

    preferredDate string
    publicNotes string
    quickOpList object[]
  • Array [
    • description string
    laborOpCode string
    opCodeDuration string
    opCodeName string
    quickOpLiteUUID string
    totalPrice string
  • ]
    • requesterUserUuid string
    serviceAdvisor object
    departmentUuid string
    isMobileServiceTechnician boolean
    isValid boolean
    userUuid string
    serviceEndTime string
    serviceStartTime string
    sprinterVehicleUuid string
    status string

    Possible values: [PENDING_APPROVAL, SCHEDULED, TRIP_IN_PROGRESS, TECHNICIAN_ARRIVED, SERVICE_IN_PROGRESS, SERVICE_COMPLETED, CANCELLED, COMPLETED, DECLINED]

    textPreference boolean
    updatedByUser object
    departmentUuid string
    isMobileServiceTechnician boolean
    isValid boolean
    userUuid string
Responses

OK

Schema
    appointmentUUID string
    error object
    code string
    description string
    metadata object
    property name* string
    statusCode int32
    warnings object[]
  • Array [
    • code string
    description string
  • ]
PATCH /appointment/:appointment_uuid

Request

Base URL
//api.mykaarma.com/mobile-service
appointment_uuid — path required
authorization — header required
Body required
{

  "appointmentKey": "string",

  "appointmentMetaData": {

    "dmsMetaData": {

      "dealerAssociateId": "string",

      "description": "string",

      "title": "SUCCESS",

      "type": "PUSH",

      "vehicleUuid": "string"

    }

  },

  "assignedUser": {

    "departmentUuid": "string",

    "isMobileServiceTechnician": true,

    "isValid": true,

    "userUuid": "string"

  },

  "customerVehicleUuid": "string",

  "dealerDepartmentUuidList": [

    "string"

  ],

  "destinationAddress": "string",

  "destinationLatitude": 0,

  "destinationLongitude": 0,

  "emailPreference": true,

  "internalNotes": "string",

  "lastMileage": "string",

  "notifyCustomer": true,

  "orderNumber": "string",

  "orderUuid": "string",

  "platform": "DEALER_APP",

  "preferredDate": "string",

  "publicNotes": "string",

  "quickOpList": [

    {

      "description": "string",

      "laborOpCode": "string",

      "opCodeDuration": "string",

      "opCodeName": "string",

      "quickOpLiteUUID": "string",

      "totalPrice": "string"

    }

  ],

  "requesterUserUuid": "string",

  "serviceAdvisor": {

    "departmentUuid": "string",

    "isMobileServiceTechnician": true,

    "isValid": true,

    "userUuid": "string"

  },

  "serviceEndTime": "string",

  "serviceStartTime": "string",

  "sprinterVehicleUuid": "string",

  "status": "PENDING_APPROVAL",

  "textPreference": true,

  "updatedByUser": {

    "departmentUuid": "string",

    "isMobileServiceTechnician": true,

    "isValid": true,

    "userUuid": "string"

  }

}
curl / cURL
curl -L -X PATCH '//api.mykaarma.com/mobile-service/appointment/:appointment_uuid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "appointmentKey": "string",
  "appointmentMetaData": {
    "dmsMetaData": {
      "dealerAssociateId": "string",
      "description": "string",
      "title": "SUCCESS",
      "type": "PUSH",
      "vehicleUuid": "string"
    }
  },
  "assignedUser": {
    "departmentUuid": "string",
    "isMobileServiceTechnician": true,
    "isValid": true,
    "userUuid": "string"
  },
  "customerVehicleUuid": "string",
  "dealerDepartmentUuidList": [
    "string"
  ],
  "destinationAddress": "string",
  "destinationLatitude": 0,
  "destinationLongitude": 0,
  "emailPreference": true,
  "internalNotes": "string",
  "lastMileage": "string",
  "notifyCustomer": true,
  "orderNumber": "string",
  "orderUuid": "string",
  "platform": "DEALER_APP",
  "preferredDate": "string",
  "publicNotes": "string",
  "quickOpList": [
    {
      "description": "string",
      "laborOpCode": "string",
      "opCodeDuration": "string",
      "opCodeName": "string",
      "quickOpLiteUUID": "string",
      "totalPrice": "string"
    }
  ],
  "requesterUserUuid": "string",
  "serviceAdvisor": {
    "departmentUuid": "string",
    "isMobileServiceTechnician": true,
    "isValid": true,
    "userUuid": "string"
  },
  "serviceEndTime": "string",
  "serviceStartTime": "string",
  "sprinterVehicleUuid": "string",
  "status": "PENDING_APPROVAL",
  "textPreference": true,
  "updatedByUser": {
    "departmentUuid": "string",
    "isMobileServiceTechnician": true,
    "isValid": true,
    "userUuid": "string"
  }
}'